Migrate doc generation tooling#6
Merged
Merged
Conversation
Migrates workflows and tooling for generating documentation from application.properties, Protobuf schemas, and OpenAPI specs. The config docs generation has been rewritten from a JBang script to Python, as that aligns better with the existing MkDocs setup. Signed-off-by: nscuro <nscuro@protonmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Migrates the documentation generation toolchain to better align with the existing MkDocs/uv-based setup, replacing prior ad-hoc generation approaches with a Python/Jinja2 generator and adding workflows to keep generated reference docs up to date.
Changes:
- Add a Python-based config documentation generator using Jinja2, plus a Jinja2 template for rendering the config reference page.
- Add Makefile targets and GitHub Actions workflows to regenerate config docs, protobuf docs, and OpenAPI specs.
- Update generated configuration properties documentation output and project docs to reflect the new tooling/lint steps.
Reviewed changes
Copilot reviewed 12 out of 14 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
pyproject.toml |
Adds Jinja2 dependency for the new config docs generator. |
uv.lock |
Updates lockfile for the added Jinja2 dependency. |
scripts/generate_config_docs.py |
New Python implementation for parsing application.properties and rendering docs. |
scripts/templates/config-docs.md.j2 |
New Jinja2 template for the configuration properties reference page. |
docs/reference/configuration/properties.md |
Regenerated configuration properties documentation with the new generator output. |
docs/reference/schemas/notification.md.tmpl |
Adds/updates protoc-gen-doc template used for notification schema docs generation. |
docs/reference/schemas/policy.md.tmpl |
Adds/updates protoc-gen-doc template used for policy schema docs generation. |
Makefile |
Adds lint-python, generate-config-docs, generate-proto-docs; includes Python linting in lint. |
README.md |
Documents new Python linting and generated-docs workflows/commands. |
AGENTS.md |
Adds guidance for Python linting and regenerating generated docs. |
.github/workflows/docs.yml |
Runs Python linting in CI. |
.github/workflows/update-config-docs.yml |
New workflow to regenerate config docs and open a PR. |
.github/workflows/update-proto-docs.yml |
New workflow to regenerate protobuf docs and open a PR. |
.github/workflows/update-openapi-docs.yml |
New workflow to download OpenAPI artifacts and open a PR with updated specs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrates workflows and tooling for generating documentation from application.properties, Protobuf schemas, and OpenAPI specs.
The config docs generation has been rewritten from a JBang script to Python, as that aligns better with the existing MkDocs setup.